Repository navigation
DX-2809: document step-level flow control and retries - #898
Merged
Merged
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Contributor
|
Docs7 for upstash.com
Commit |
context7
Bot
temporarily deployed
to
Docs7 Preview: DX-2809-step-level-flow-control
October 7, 2026 09:53
Destroyed
CahidArda
marked this pull request as ready for review
October 28, 2026 10:03
Copilot stopped reviewing on behalf of
CahidArda due to an error
October 28, 2026 10:24
Copilot stopped reviewing on behalf of
CahidArda due to an error
October 28, 2026 10:45
Contributor
There was a problem hiding this comment.
Note
Copilot was unable to run its full agentic suite in this review.
Copilot review overview
4 open issues
typescript(\"Configure Retries for a… · NewflowControl/retries/retryDelayare passed directly as the third… · Newoptionsproperties appear to be optional overrides (unset fields fall back to the run… · New
What changed in this PR
Adds documentation for per-step overrides of flow control and retry behavior in Upstash Workflow, and exposes the applied configuration on the context object.
Changes:
- Document
context.runstep-level options (flowControl,retries,retryDelay) and link to the relevant feature guides. - Add docs explaining step-level flow control behavior (including when an extra request is published).
- Add a new “Configure retries for a single step” section and update “configure” how-to links.
| File | Description |
|---|---|
| workflow/steps/run.mdx | Documents a new optional options argument for context.run with flow control + retry overrides. |
| workflow/steps.mdx | Documents context.flowControl, context.retries, and context.retryDelay fields. |
| workflow/howto/configure.mdx | Updates links and revises guidance to mention step-level overrides for context.run. |
| workflow/features/retries.mdx | Adds a section showing how to override retries/retryDelay for a single step. |
| workflow/features/flow-control.mdx | Adds a “Step-level Flow Control” section describing per-step overrides and implications. |
| llms-full.txt | Mirrors the documentation updates in the aggregated LLM export. |
Review effort: Lite
| `context.sleepUntil` step, its configuration is attached to the request which delivers it, at no extra cost. | ||
| In other cases (for example, when it is the first step of a run or comes after a `context.call`), | ||
| the SDK publishes an additional hidden request to apply the configuration. This request is not shown in the | ||
| workflow logs. |
|
|
||
| The retry configuration of a run applies to all of its steps. You can override it for a single `context.run` | ||
| step by passing `retries` and `retryDelay` as the third argument: | ||
|
|
| If you want to specifically throttle a step, there is a workaround by splitting step to another workflow and using `context.invoke()`. | ||
| </Tip> No newline at end of file | ||
| A single `context.run` step can override the run's flow control and retry configuration by passing | ||
| `flowControl`, `retries` or `retryDelay` as its third argument. See |
Comment on lines
+29
to
+38
| <ParamField body="flowControl" type="object"> | ||
| Flow control configuration with `key`, `rate`, `parallelism` and `period`, the same shape as in | ||
| [client.trigger](/workflow/basics/client/trigger). Replaces the run's flow control for this step. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="retries" type="number"> | ||
| How many times the step is retried when it fails. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="retryDelay" type="string"> |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs for step-level flow control and retries (
context.run(name, fn, { flowControl, retries, retryDelay })).SDK: upstash/workflow-js#206 · Server: upstash/qstash-server#1058 (merged, in v2.40.6+)
optionsargumentcontext.flowControl,context.retries,context.retryDelaycontext.runDraft until the SDK release that ships #206.